home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-20 / bb21c.zip / ACTION.DOC < prev    next >
Text File  |  1993-02-15  |  10KB  |  294 lines
  1. The action file includes all sorts of things to be done.  The operations
  2. are shown below.  {search} is any search for a message as specified in
  3. SEARCH.DOC.  Comments are any line that starts with ; or * There are two
  4. types of operations:  Immediate and Deferred.  Immediate actions occur
  5. during command processing or messages being received.  Deferred actions
  6. occur only when the proper "A" command is executed.
  7.  
  8. IMMEDIATE ACTIONS
  9. --------- -------
  10.  
  11.     HOLD {search}
  12.  
  13.       This says to hold a message that matches the search.  Files will be
  14.       marked as held by SYSOP.  {search} is any search for a message as
  15.       specified in SEARCH.DOC.
  16.  
  17.       Example:
  18.  
  19.           HOLD < AA4RE
  20.  
  21.           Holds all messages from AA4RE
  22.  
  23.     REVIEW {search}
  24.  
  25.       This says to put a message in review status that matches the search.
  26.       {search} is any search for a message as specified in SEARCH.DOC.
  27.  
  28.       Example:
  29.  
  30.           REVIEW % AA4RE
  31.  
  32.           Mark for review all messages created locally at AA4RE
  33.  
  34.     HOLD_OLD {search}
  35.  
  36.       This says to hold a message that matches the search but reason will
  37.       be too old rather than help by operator.  {search} is any search for
  38.       a message as specified in SEARCH.DOC.
  39.  
  40.       Example:
  41.  
  42.           HOLD < AA4RE
  43.  
  44.           Holds all messages from AA4RE
  45.  
  46.     REJECT {search}
  47.  
  48.       This says to reject a message that matches the search.  A rejected
  49.       message may not even arrive at the BBS.  Also see the parameter
  50.       REJECT_ACTION in PARMS.DOC.  {search} is any search for a message as
  51.       specified in SEARCH.DOC.
  52.  
  53.       Example:
  54.  
  55.           REJECT > SALE & @ USA
  56.  
  57.           Rejects all messages addressed to SALE @ USA
  58.  
  59.       Note:  The first pass at a reject action occurs when just the
  60.       the send command is received.  Some fields are not available
  61.       for testing like SUBJECT and FROM-BBS.
  62.  
  63.     DENY_NEW_MSG {message_num} {search}
  64.  
  65.       This says to not permit a user to originate a message at this BBS.
  66.       The {message_num} parameter indicates which message is to be
  67.       displayed if the {search} is met.  It will be between 0 at 9. The
  68.       real message number will be 140 + this parameter.  {search} is any
  69.       search for a message as specified in SEARCH.DOC.
  70.  
  71.       Examples:
  72.  
  73.           DENY_NEW_MSG 3 > SALE & @ USA
  74.  
  75.              Rejects all messages addressed to SALE @ USA and uses
  76.              message # 143
  77.  
  78.           DENY_NEW_MSG 2 C U & ^ > SYSOP
  79.  
  80.              Reject any messages from new or unregistered users unless
  81.              addressed to SYSOP and uses message # 142
  82.  
  83.       Note:  The deny action will be checked twice.  Once before the
  84.       subject is available and once afterwards.
  85.  
  86.       Note 2:  DENY_NEW_MSG should appear before REJECT and HOLD in the
  87.       ACTION.BB
  88.  
  89.     TELL_AFTER_SUBJECT {message_num} {search}
  90.     TELL_AT_END        {message_num} {search}
  91.  
  92.       This says to tell the user something during a send message command
  93.       either:
  94.          1) after the subject is processed
  95.          2) at the end
  96.  
  97.       The {message_num} parameter indicates which message is to be
  98.       displayed if the {search} is met.  It will be between 0 at 9. The
  99.       real message number will be 190 + this parameter.  {search} is any
  100.       search for a message as specified in SEARCH.DOC.
  101.  
  102.       Examples:
  103.  
  104.           TELL_AFTER_SUBJECT 3 > SALE & @ USA
  105.  
  106.              Tells user something about a message addressed to SALE @ USA and
  107.              uses message # 193
  108.  
  109.           TELL_AT_END 2 !S > 5000
  110.  
  111.              Tells user something about a message whose size is more than
  112.              5000 bytes and uses message # 192
  113.  
  114.     CHANGE_ADR {search} => {address}
  115.  
  116.       Changes an address.  {search} is any search for a message as
  117.       specified in SEARCH.DOC.  {address} is a standard packet address in
  118.       the form of "xxxx @ yyyy.zzzz". xxxx must be supplied and valid.  The
  119.       others can be omitted but the defaults may not fit what you want.
  120.       Any of the three (xxxx, yyyy, or zzzz) can be "=" which means leave
  121.       the same as before or the special word "NONE" which means to erase
  122.       this part of the address.
  123.  
  124.       Examples:
  125.  
  126.          CHANGE_ADR & @ USA => = @ ALLUS
  127.          CHANGE_ADR > 4SALE & @ USA => SALE @ =
  128.  
  129.     DISTRIBUTE {name} {search}
  130.  
  131.       Specifies which distribution/carbon-copy list is to be used.  If
  132.       {name} is a simple word, it will follow the normal name resolution.
  133.       If {name} is an actual file, that will supersede the name resolution
  134.       system.  Note that carbon-copy lists must have an extension of '.CC'.
  135.       {search} is any search for a message as specified in SEARCH.DOC.
  136.  
  137.       Examples:
  138.  
  139.           DISTRIBUTE ALLCA @ ALLUS
  140.  
  141.              Use ALLCA for messages addressed to ALLUS.  First ALLCA.CC
  142.              will be tried then ALLCA.DIS.
  143.  
  144.           DISTRIBUTE C:\BB\DISTINFO\ALLCA.DIS @ ALLUS
  145.  
  146.              Use the file C:\BB\DISTINFO\ALLCA.DIS for messages addressed
  147.              to ALLUS.
  148.  
  149.     DEFINE_USER_COMMAND     {alias} {real command}
  150.     DEFINE_OPERATOR_COMMAND {alias} {real command}
  151.  
  152.       This allows you to define some alias for a command.  The first word
  153.       on all commands is matched against the alias.  When the match occurs,
  154.       the real command is executed.  The real command is expanded by the
  155.       using the "$" substitution.  $1 contains the parameters originally
  156.       on the line.
  157.  
  158.       Examples:
  159.  
  160.          DEFINE_USER_COMMAND LAST LL $1
  161.  
  162.          When a user executes "LAST 3", it is converted to "LL 3"
  163.  
  164.       Note that the privilege class of the substituted command is IGNORED
  165.       thus the following is legal:
  166.  
  167.          DEFINE_USER_COMMAND SEARCHDB EX [AOS] MYPROG.COM $y $1
  168.  
  169.       DEFINE_OPERATOR_COMMAND will only work for the operator (remote
  170.       and local) while DEFINE_USER_COMMAND works for everyone.
  171.  
  172.  
  173. DEFERRED ACTIONS
  174. -------- -------
  175.  
  176.     MAKE_FILE            {options} {fileid} {search}
  177.     MAKE_FILE_REPLACE
  178.     MAKE_FILE_APPEND
  179.  
  180.       Makes a file from a message.  {fileid} is the file to be used be
  181.       used.  Substitution parameters that are the same as for messages
  182.       (see MESSAGE.BB) can be used.  The file must not exist for MAKE_FILE.
  183.       If MAKE_FILE_REPLACE is used, then if the file already exists, it
  184.       will be replaced.  If MAKE_FILE_APPEND is used, the the message will
  185.       be added at the end of the file; if the file doesn't exist, it will
  186.       be created.  {search} is any search for a message as specified in
  187.       SEARCH.DOC.
  188.  
  189.       {options} are enclosed in square brackets and do not have to
  190.       be present.  The only valid option is "K" which kills the message
  191.       after the file is made.
  192.  
  193.       Examples:
  194.  
  195.          MAKE_FILE C:\RACES\$b > RACES & $ RACESBUL.*
  196.  
  197.          Change anything addressed to RACES with a BID of RACESBUL into a
  198.          file and stick it into the RACES subdirectory
  199.  
  200.          MAKE_FILE_REPLACE C:\ARRL\ARRLPROP $ ARLP*
  201.  
  202.          A propagation bulletin will replace its predecessor in the file
  203.          called ARRLPROP.
  204.  
  205.          MAKE_FILE [K] $M.OP > SYSOP & F
  206.  
  207.          Makes messages to SYSOP into files after they are forwarded.
  208.          In addition, the messages are killed once the file is made.
  209.  
  210.     CLEAN_MSGS {type} {search}
  211.  
  212.       Used for general message housekeeping.  Its purpose is to remove
  213.       superseded messages like AMSAT orbital data.  {type} indicates ARRL,
  214.       AMSAT, RACES, RTTYDX, GENERATE, or DATE.  This refers to how the BID
  215.       is used.  Both RACES and ARRL bids end in numbers but the ARRL
  216.       numbers are recycled at the end of the year.  AMSAT news and orbital
  217.       data have the format that looks like xxx-ddd.vv where the applicable
  218.       number (ddd) is just in front of the "."  RTTYDX uses a format of
  219.       xxxxxxxdddx.  If the GENERATE {type} is used, the standard
  220.       generated bid of dddddd_bbs is assumed.  If {type} is DATE, then only
  221.       the last message received will be kept and the bid is ignored.
  222.       {search} is any search for a message as specified in SEARCH.DOC.
  223.  
  224.       Examples:
  225.  
  226.          CLEAN_MSGS ARRL  $ ARLP###
  227.          CLEAN_MSGS ARRL  $ ARLD###
  228.          CLEAN_MSGS ARRL  $ ARLS###
  229.          CLEAN_MSGS AMSAT $ ORBS-###.*
  230.          CLEAN_MSGS AMSAT $ ANS-###.##
  231.          CLEAN_MSGS RACES $ RACESBUL.###
  232.          CLEAN_MSGS RTTYDX $ RTDX####=
  233.  
  234.       These examples clean away old ARRL DX bulletins, prop bulletins,
  235.       satellite bulletins, AMSAT orbital data, AMSAT news, and RACES
  236.       bulletins.
  237.  
  238.       Note 1:  Both AMSAT and ARRL types have special code to cover the
  239.       yearend wrap (Example: when ARLD052 is followed by ARLD001)
  240.  
  241.       Note 2:  GENERATE has special code to ignore the distant BBS doing
  242.       a message renumber.
  243.  
  244.  
  245. ORDERING
  246. --------
  247.  
  248. The first match that is seen will be acted on.  Example
  249.  
  250.    REJECT > SALE & @ USA
  251.    HOLD @ USA
  252.  
  253. A message addressed to SALE @ USA will be rejected because the REJECT is
  254. seen first.  The message addressed to ALL @ USA will just be held.
  255.  
  256. Also, the order is import for CHANGE_ADR and HOLD.  Example:
  257.  
  258.    HOLD @ ALLUS
  259.    CHANGE @ USA => = @ ALLUS
  260.  
  261. Messages @ USA will NOT be held since the change action is executed
  262. after the HOLD action.
  263.  
  264. One further example:
  265.  
  266.    CHANGE_ADR > SYSOP & @ AA4RE => AA4RE
  267.    CHANGE_ADR @ AA4RE => = @ NONE
  268.  
  269.       If a message comes in addressed to SYSOP @ AA4RE, it is readdressed
  270.       to AA4RE @ AA4RE.  Why not AA4RE @ (blank)?  The first line satisfied
  271.       the search so the search stopped.  The correct way to do this is:
  272.  
  273.    CHANGE_ADR > SYSOP & @ AA4RE => AA4RE @ NONE
  274.    CHANGE_ADR @ AA4RE => = @ NONE
  275.  
  276. You must make all the action happen with the one line!
  277.  
  278.  
  279. NEGATION
  280. --------
  281.  
  282. Putting a NO in front of a word will negate it.  Example:
  283.  
  284.    NOHOLD > SALE & @ USA
  285.    HOLD @ USA
  286.  
  287. A message addressed to SALE @ USA will go thru because the NOHOLD is
  288. seen first.  The message addressed to ALL @ USA will be held.
  289.  
  290. Note:  NOCHANGE_ADR does not require the => xxxx @ yyyy.ZZZZ portion.
  291. Example:
  292.  
  293.    NOCHANGE > ALL & @ USA
  294.